home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / gas_251.zip / bin_251 / bfd / format.c < prev    next >
C/C++ Source or Header  |  1994-06-20  |  9KB  |  319 lines
  1. /* Generic BFD support for file formats.
  2.    Copyright (C) 1990, 91, 92, 93, 94 Free Software Foundation, Inc.
  3.    Written by Cygnus Support.
  4.  
  5. This file is part of BFD, the Binary File Descriptor library.
  6.  
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11.  
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with this program; if not, write to the Free Software
  19. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20.  
  21. /*
  22. SECTION
  23.     File formats
  24.  
  25.     A format is a BFD concept of high level file contents type. The
  26.     formats supported by BFD are: 
  27.  
  28.     o <<bfd_object>>
  29.  
  30.     The BFD may contain data, symbols, relocations and debug info.
  31.  
  32.     o <<bfd_archive>>
  33.  
  34.     The BFD contains other BFDs and an optional index.
  35.  
  36.     o <<bfd_core>>
  37.  
  38.     The BFD contains the result of an executable core dump.
  39.  
  40.  
  41. */
  42.  
  43. #include "bfd.h"
  44. #include "sysdep.h"
  45. #include "libbfd.h"
  46.  
  47. /* IMPORT from targets.c.  */
  48. extern const size_t _bfd_target_vector_entries;
  49.  
  50. /*
  51. FUNCTION
  52.     bfd_check_format
  53.  
  54. SYNOPSIS
  55.     boolean bfd_check_format(bfd *abfd, bfd_format format);
  56.  
  57. DESCRIPTION
  58.     Verify if the file attached to the BFD @var{abfd} is compatible
  59.     with the format @var{format} (i.e., one of <<bfd_object>>,
  60.     <<bfd_archive>> or <<bfd_core>>).
  61.  
  62.     If the BFD has been set to a specific target before the
  63.     call, only the named target and format combination is
  64.     checked. If the target has not been set, or has been set to
  65.     <<default>>, then all the known target backends is
  66.     interrogated to determine a match.  If the default target
  67.     matches, it is used.  If not, exactly one target must recognize
  68.     the file, or an error results.
  69.  
  70.     The function returns <<true>> on success, otherwise <<false>>
  71.     with one of the following error codes:  
  72.  
  73.     o <<bfd_error_invalid_operation>> -
  74.     if <<format>> is not one of <<bfd_object>>, <<bfd_archive>> or
  75.     <<bfd_core>>.
  76.  
  77.     o <<bfd_error_system_call>> -
  78.     if an error occured during a read - even some file mismatches
  79.     can cause bfd_error_system_calls.
  80.  
  81.     o <<file_not_recognised>> -
  82.     none of the backends recognised the file format.
  83.  
  84.     o <<bfd_error_file_ambiguously_recognized>> -
  85.     more than one backend recognised the file format.
  86. */
  87.  
  88. boolean
  89. bfd_check_format (abfd, format)
  90.      bfd *abfd;
  91.      bfd_format format;
  92. {
  93.   return bfd_check_format_matches (abfd, format, NULL);
  94. }
  95.  
  96. /*
  97. FUNCTION
  98.     bfd_check_format_matches
  99.  
  100. SYNOPSIS
  101.     boolean bfd_check_format_matches(bfd *abfd, bfd_format format, char ***matching);
  102.  
  103. DESCRIPTION
  104.     Like <<bfd_check_format>>, except when it returns false with
  105.     <<bfd_errno>> set to <<bfd_error_file_ambiguously_recognized>>.  In that
  106.     case, if @var{matching} is not NULL, it will be filled in with
  107.     a NULL-terminated list of the names of the formats that matched,
  108.     allocated with <<malloc>>.
  109.     Then the user may choose a format and try again.
  110.  
  111.     When done with the list that @var{matching} points to, the caller
  112.     should free it.  
  113. */
  114.  
  115. boolean
  116. bfd_check_format_matches (abfd, format, matching)
  117.      bfd *abfd;
  118.      bfd_format format;
  119.      char ***matching;
  120. {
  121.   const bfd_target * const *target, *save_targ, *right_targ;
  122.   char **matching_vector = NULL;
  123.   int match_count;
  124.  
  125.   if (!bfd_read_p (abfd) ||
  126.       ((int)(abfd->format) < (int)bfd_unknown) ||
  127.       ((int)(abfd->format) >= (int)bfd_type_end)) {
  128.     bfd_set_error (bfd_error_invalid_operation);
  129.     return false;
  130.   }
  131.  
  132.   if (abfd->format != bfd_unknown)
  133.     return (abfd->format == format)? true: false;
  134.  
  135.  
  136.   /* Since the target type was defaulted, check them 
  137.      all in the hope that one will be uniquely recognized.  */
  138.  
  139.   save_targ = abfd->xvec;
  140.   match_count = 0;
  141.   if (matching)
  142.     {
  143.       matching_vector =
  144.     (char **) malloc (sizeof (char *) *
  145.               (_bfd_target_vector_entries + 1));
  146.       if (!matching_vector)
  147.     {
  148.       bfd_set_error (bfd_error_no_memory);
  149.       return false;
  150.     }
  151.       matching_vector[0] = NULL;
  152.       *matching = matching_vector;
  153.     }
  154.   right_targ = 0;
  155.  
  156.  
  157.   /* presume the answer is yes */
  158.   abfd->format = format;
  159.  
  160.   /* If the target type was explicitly specified, just check that target.  */
  161.  
  162.   if (!abfd->target_defaulted) {
  163.     if (bfd_seek (abfd, (file_ptr)0, SEEK_SET) != 0)    /* rewind! */
  164.       return false;
  165.     right_targ = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
  166.     if (right_targ) {
  167.       abfd->xvec = right_targ;        /* Set the target as returned */
  168.       if (matching)
  169.     free (matching_vector);
  170.       return true;            /* File position has moved, BTW */
  171.     }
  172.   }
  173.  
  174.   for (target = bfd_target_vector; *target != NULL; target++) {
  175.     const bfd_target *temp;
  176.  
  177.     abfd->xvec = *target;    /* Change BFD's target temporarily */
  178.     if (bfd_seek (abfd, (file_ptr)0, SEEK_SET) != 0)
  179.       return false;
  180.     /* If _bfd_check_format neglects to set bfd_error, assume bfd_error_wrong_format.
  181.        We didn't used to even pay any attention to bfd_error, so I suspect
  182.        that some _bfd_check_format might have this problem.  */
  183.     bfd_set_error (bfd_error_wrong_format);
  184.     temp = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
  185.     if (temp) {                /* This format checks out as ok! */
  186.       right_targ = temp;
  187.       if (matching)
  188.     {
  189.       matching_vector[match_count] = temp->name;
  190.       matching_vector[match_count + 1] = NULL;
  191.     }
  192.       match_count++;
  193.       /* If this is the default target, accept it, even if other targets
  194.      might match.  People who want those other targets have to set 
  195.      the GNUTARGET variable.  */
  196.       if (temp == bfd_default_vector[0])
  197.     {
  198.       if (matching)
  199.         {
  200.           matching_vector[0] = temp->name;
  201.           matching_vector[1] = NULL;
  202.         }
  203.       match_count = 1;
  204.       break;
  205.     }
  206. #ifdef GNU960
  207.       /* Big- and little-endian b.out archives look the same, but it doesn't
  208.        * matter: there is no difference in their headers, and member file byte
  209.        * orders will (I hope) be handled appropriately by bfd.  Ditto for big
  210.        * and little coff archives.  And the 4 coff/b.out object formats are
  211.        * unambiguous.  So accept the first match we find.
  212.        */
  213.       break;
  214. #endif
  215.     } else if (bfd_get_error () != bfd_error_wrong_format) {
  216.       abfd->xvec = save_targ;
  217.       abfd->format = bfd_unknown;
  218.       if (matching && bfd_get_error () != bfd_error_file_ambiguously_recognized)
  219.     free (matching_vector);
  220.       return false;
  221.     }
  222.   }
  223.  
  224.   if (match_count == 1) {
  225.     abfd->xvec = right_targ;        /* Change BFD's target permanently */
  226.     if (matching)
  227.       free (matching_vector);
  228.     return true;            /* File position has moved, BTW */
  229.   }
  230.  
  231.   abfd->xvec = save_targ;        /* Restore original target type */
  232.   abfd->format = bfd_unknown;        /* Restore original format */
  233.   if (match_count == 0)
  234.     {
  235.       bfd_set_error (bfd_error_file_not_recognized);
  236.       if (matching)
  237.     free (matching_vector);
  238.     }
  239.   else
  240.     bfd_set_error (bfd_error_file_ambiguously_recognized);
  241.   return false;
  242. }
  243.  
  244. /*
  245. FUNCTION
  246.     bfd_set_format
  247.  
  248. SYNOPSIS
  249.     boolean bfd_set_format(bfd *abfd, bfd_format format);
  250.  
  251. DESCRIPTION
  252.     This function sets the file format of the BFD @var{abfd} to the
  253.     format @var{format}. If the target set in the BFD does not
  254.     support the format requested, the format is invalid, or the BFD
  255.     is not open for writing, then an error occurs.
  256.  
  257. */
  258.  
  259. boolean
  260. bfd_set_format (abfd, format)
  261.      bfd *abfd;
  262.      bfd_format format;
  263. {
  264.  
  265.   if (bfd_read_p (abfd) ||
  266.       ((int)abfd->format < (int)bfd_unknown) ||
  267.       ((int)abfd->format >= (int)bfd_type_end)) {
  268.     bfd_set_error (bfd_error_invalid_operation);
  269.     return false;
  270.   }
  271.  
  272.   if (abfd->format != bfd_unknown)
  273.     return (abfd->format == format) ? true:false;
  274.  
  275.   /* presume the answer is yes */
  276.   abfd->format = format;
  277.  
  278.   if (!BFD_SEND_FMT (abfd, _bfd_set_format, (abfd))) {
  279.     abfd->format = bfd_unknown;
  280.     return false;
  281.   }
  282.  
  283.   return true;
  284. }
  285.  
  286.  
  287. /*
  288. FUNCTION
  289.     bfd_format_string
  290.  
  291. SYNOPSIS
  292.     CONST char *bfd_format_string(bfd_format format);
  293.  
  294. DESCRIPTION
  295.     Return a pointer to a const string
  296.     <<invalid>>, <<object>>, <<archive>>, <<core>>, or <<unknown>>,
  297.     depending upon the value of @var{format}.
  298. */
  299.  
  300. CONST char *
  301. bfd_format_string (format)
  302.      bfd_format format;
  303. {
  304.   if (((int)format <(int) bfd_unknown) 
  305.       || ((int)format >=(int) bfd_type_end)) 
  306.     return "invalid";
  307.   
  308.   switch (format) {
  309.   case bfd_object:
  310.     return "object";        /* linker/assember/compiler output */
  311.   case bfd_archive: 
  312.     return "archive";        /* object archive file */
  313.   case bfd_core: 
  314.     return "core";        /* core dump */
  315.   default: 
  316.     return "unknown";
  317.   }
  318. }
  319.